Update Acquirer Link
Operation to create or update a merchant's acquirer link.
Authentication
This operation requires authentication via one of the following methods:
- Certificate authentication.
-
Basic HTTP authentication as described at
w3.org.
Provide 'MSO.
<your gateway MSO ID>' in the userid portion and your API password in the password portion.
Request
URL Parameters
Alphanumeric + additional characters
REQUIRED
The identifier that uniquely identifies you on the gateway.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'
Min length: 1 Max length: 16Alphanumeric + additional characters
REQUIRED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Min length: 1 Max length: 36Fields
String
= UPDATE_MERCHANT_ACQUIRER_LINK
FIXED
Any sequence of zero or more unicode characters.
String
OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
The merchant's details.
The merchant's acquirer link details.
Comma separated enumeration
OPTIONAL
The transaction frequency the merchant will be allowed to set when initiating a transaction.
You may select multiple transaction frequencies.
Value must be one or more comma separated members of the following list. The values are case sensitive.
INSTALLMENTS
The transaction identifies a payment that is paid off in installments.
RECURRING
The transaction is one in a number of recurring payments.
SINGLE_TRANSACTION
The transaction identifies a one-off payment.
Comma separated enumeration
OPTIONAL
The transaction sources the merchant will be allowed to set when initiating a transaction.
You may select multiple transaction sources.
Value must be one or more comma separated members of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
String
OPTIONAL
The time each day, at which automatic settlement of transactions with the acquirer should be triggered by the gateway.
Data can consist of any characters
Digits
OPTIONAL
The industry code that the merchant operates in, as used by the financial institution.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The Bank Merchant ID/SE Number is an identifier allocated to the merchant by their acquiring bank.
If you set up more than one acquirer link for a single acquirer, these do not need to use the same Bank Merchant ID.
Data can consist of any characters
Comma separated enumeration
OPTIONAL
The list of valid card types supported by this merchant acquirer link.
Value must be one or more comma separated members of the following list. The values are case sensitive.
AMEX
AMEX_PURCHASE_CARD
BANAMEX_COSTCO
CARNET
CARTE_BANCAIRE
COSTCO_MEMBER_CREDIT
DINERS_CLUB
DISCOVER
EBT
ELO
FARMERS_CARD
JCB
LASER
MAESTRO
MASTERCARD
MASTERCARD_PURCHASE_CARD
PRIVATE_LABEL_CARD
RUPAY
Q_CARD
SORIANA
TRUE_REWARDS
UATP
VISA
VISA_DEBIT
VISA_PURCHASE_CARD
Alphanumeric
REQUIRED
The list of currencies supported for this merchant acquirer link, expressed using the three-letter alphabetic code according to ISO-4217must be provided, e.g. "USD" for United States Dollar.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
REQUIRED
The merchants default transaction frequency must be one of the allowable transaction frequencies for this merchant.
Defines the transaction frequency set, if none has been provided for that transaction.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENTS
The transaction identifies a payment that is paid off in installments.
RECURRING
The transaction is one in a number of recurring payments.
SINGLE_TRANSACTION
The transaction identifies a one-off payment.
Enumeration
REQUIRED
The merchants default transaction source must be one of the allowable transaction sources for this merchant.
Defines the transaction source sent to the acquirer, if none has been provided for that transaction.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
Comma separated enumeration
OPTIONAL
Allows you to specify transaction sources for which a Card Security Code (CSC) must be provided when processing transactions using this merchant acquirer link.
CSC enforcement does not apply to: - Card Present transactions - transactions where the transaction frequency is Recurring or Installment. - transactions where the merchant has the 'May Use No CSC Printed on Card' merchant privilege enabled, and the merchant operator selects the 'No CSC Printed on Card' option when creating an order. - transactions with Maestro cards for a transaction source of Internet. CSC enforcement only applies to Authorization, Purchase, and Standalone Capture transactions."
Value must be one or more comma separated members of the following list. The values are case sensitive.
CALL_CENTRE
The merchant can set Call Centre as the transaction source when initiating a transaction.
CARD_PRESENT
The merchant can set Card Present as the transaction source when initiating a transaction.
INTERNET
The merchant can set Internet as the transaction source when initiating a transaction.
MAIL_ORDER
The merchant can set Mail Order as the transaction source when initiating a transaction.
MOTO
The merchant can set Mail Order/Telephone Order (MOTO) as the transaction source when initiating a transaction.
TELEPHONE_ORDER
The merchant can set Telephone Order as the transaction source when initiating a transaction.
VOICE_RESPONSE
The merchant can set Voice Response as the transaction source when initiating a transaction.
String
OPTIONAL
Description of the goods sold by the merchant, for example, books or electronics.
Data can consist of any characters
Enumeration
REQUIRED
The payment types supported by this acquirer via this merchant acquirer link.
Value must be a member of the following list. The values are case sensitive.
CREDIT
The acquirer supports credit cards, debit cards such as Maestro Debit card, and/or Visa debit cards.
GIROPAY
The acquirer supports giropay online browser payments.
PAYPAL
The acquirer supports PayPal online browser payments.
SOFORTBANKING
The acquirer supports Sofortbanking online browser payments.
Enumeration
REQUIRED
Defines if the merchant can use the acquirer link and if so, for what purpose.
Note:
Setting the value to FALLBACK can be used to support moving processing of the merchant's transactions from one acquirer link to another.
When moving transaction processing from one link to another, the status of the new link is set to TEST_AND_PRODUCTION or TEST_ONLY, and the status of the old link is set to FALLBACK. In this case,
- New orders will be processed using the new link, and
- Subsequent transactions for orders created using the old link will be processed on the old link.
Value must be a member of the following list. The values are case sensitive.
DISABLED
The acquirer link can no longer be used by the merchant.
FALLBACK
The acquirer link is used to process transactions when no other suitable test or production link is available, or to process subsequent transactions on a order that was created on this link.
TEST_AND_PRODUCTION
The acquirer link can be used for testing and processing live transactions.
TEST_ONLY
The acquirer link can be used for testing only but not processing live transactions.
Alphanumeric
OPTIONAL
The unique identifiers for the terminal IDs, that the acquirer assigned to the merchant.
Data may consist of the characters 0-9, a-z, A-Z
Details about the 3D-Secure configuration for this merchant acquirer link.
Details about the American Express SafeKey (3D-Secure) configuration for this merchant acquirer link.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use American Express SafeKey.
Data can consist of any characters
Details about the J/Secure (3D-Secure) configuration for this merchant acquirer link.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use J/Secure.
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use J/Secure.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Details about the MasterCard SecureCode (3D-Secure) configuration for this merchant acquirer link.
String
OPTIONAL
Merchant ID provided to the merchant by their acquirer when they registered to use MasterCard SecureCode.
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use MasterCard SecureCode.
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Details about the Verified by Visa (3D-Secure) configuration for this merchant acquirer link.
String
OPTIONAL
Card Acceptor ID provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
Data can consist of any characters
String
OPTIONAL
Card Acceptor Terminal ID provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
Data can consist of any characters
String
OPTIONAL
Merchant Password provided to the merchant by their acquirer when they registered to use Verified by Visa (3-D Secure).
If a password is set, the field does not return the actual password, but the value 'xxxxxx'.
Data can consist of any characters
Details that are specific for a specific acquirer.
Details regarding a B+S Card Services acquirer link configuration.
Enumeration
OPTIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
Details regarding a CIC acquirer link configuration.
Enumeration
OPTIONAL
The industry code that the merchant operates in, as used by the financial institution.
Value must be a member of the following list. The values are case sensitive.
ADULT
AIRLINE
AUCTION
DIGITAL_CONTENT
E_TICKETING
GAMBLING
GAMING
HOTEL
ONLINE_FINANCIAL
RETAIL
SERVICES
TRAVEL
UTILITIES
Alphanumeric
OPTIONAL
Provider key (Key) required to access the processing system.
The merchant receives this information when they set up an account with CIC.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider password (Passphrase) required to access the processing system.
The merchant receives this information when they set up an account with CIC
Data may consist of the characters 0-9, a-z, A-Z
Details regarding a Cielo acquirer link configuration.
Alphanumeric
OPTIONAL
Provider key (chave) required to access the processing system.
The merchant receives this information when they set up an account with Cielo.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding a giropay acquirer link configuration.
Digits
OPTIONAL
The merchant is issued an Acquirer Merchant ID when they sign up with a giropay acquirer.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The merchant is issued an External Merchant ID when they sign up with a giropay acquirer.
Data can consist of any characters
String
OPTIONAL
The merchant is issued an External Merchant Tag when they sign up with a giropay acquirer.
Data can consist of any characters
Digits
OPTIONAL
Bank account number of the merchant's bank account.
The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Bank identifier of the merchant's bank account.
Must be 8 digits. Add leading zeros if required. The customer will transfer the money into this bank account.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Bank account holder name of the merchant's bank account.
The customer will transfer the money into this bank account.
Data can consist of any characters
Details regarding a Global Payments East acquirer link configuration.
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Details regarding a Paymenttech Tampa acquirer link configuration.
Digits
OPTIONAL
Sent to the acquirer in authorization, authorization reversals, sysreversals and batch settlement requests.
Data is a string that consists of the characters 0-9.
Details regarding a PayPal acquirer link configuration.
Email
OPTIONAL
The email address of the merchant's PayPal business account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Email
OPTIONAL
The email address of the merchant's PayPal Sandbox account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Details regarding a Redecard acquirer link configuration.
Alphanumeric
OPTIONAL
Provider password (Pwd) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
Provider user name (Usr) required to access the processing system.
The merchant receives this information when they set up an account with Redecard.
Data may consist of the characters 0-9, a-z, A-Z
Details regarding a Sofortbanking acquirer link configuration.
String
OPTIONAL
The merchant must activate input verification in their Sofortbanking account.
The notification password must be the same as the one in the merchants Sofortbanking account and is used by to generate a hash value that is used to securely identify the messages received from Sofortbanking.
Data can consist of any characters
Digits
OPTIONAL
The merchant is issued a Project ID (Projektnummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The merchant must activate input verification in their Sofortbanking account.
The project password must be the same as the one in the merchants Sofortbanking account and is used to generate a hash value that is used to securely identify the messages sent to Sofortbanking.
Data can consist of any characters
Digits
OPTIONAL
The merchant is issued a user ID (Kundennummer) when they sign up with Sofortbanking.
Data is a string that consists of the characters 0-9.
Details regarding a TSYS acquirer link configuration.
String
OPTIONAL
Identifies the institution that signs the merchant.
Data can consist of any characters
String
OPTIONAL
The merchant chain identification number.
Data can consist of any characters
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Identifies a specific merchant store within the TSYS Acquiring Solutions' system.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Processor specific time zone differential.
Data can consist of any characters
String
OPTIONAL
The merchant assigned Terminal ID Number.
Data can consist of any characters
Details regarding a Vantiv acquirer link configuration.
Digits
OPTIONAL
The merchant's Bank Identification Number (BIN).
Will be submitted to the acquirer with each transactions sent for processing.
Data is a string that consists of the characters 0-9.
Enumeration
REQUIRED
The unique identifier for the acquirer issued by the gateway.
Please refer to the documentation for a list of supported acquirers and their ID.
Merchant Boarding API supported acquirers
Value must be a member of the following list. The values are case sensitive.
AIB
AMEXGWS
AMEXLAC
ANZ
BANK_IRELAND
BANK_SCOTLAND
BARCLAYS
BS_CARD_SVC_PP
CBA
CIC_PP
CIELO
CITIBANK
COMPASS
DINERS
DINERSCENTRAL
DINERS_UK
DISCOVER
EGLOBAL
FDMSHC
GIROBANK
GIROPAY
GLOBAL_PAY_EAST
HSBC
JCB
LITLE
LLOYDS_CARDNET
NAB
PAYMENTECH_SALEM
PAYMENTECH_TAMPA
PAYPAL
RBS_STREAMLINE
REDECARD
SOFORTBANKING
STGEORGE
TSYS
VANTIV
WBC
Details regarding payment plans supported for this merchant acquirer link.
Digits
OPTIONAL
The maximum number of installments that is supported for this merchant acquirer link.
Please refer to the Online Integration Guide for the allowed values depending on the payment plans.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The ID of the payment plan you want to enable for the merchant acquirer link (e.g. PlanN).
Please refer to the Online Integration Guide for the payment plans supported and their IDs.
Data can consist of any characters
Response
Fields
String
CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Enumeration
ALWAYS PROVIDED
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
FAILURE
The operation was declined or rejected by the gateway, acquirer or issuer
PENDING
The operation is currently in progress or pending processing
SUCCESS
The operation was successfully processed
UNKNOWN
The result of the operation is unknown
Errors
Information on possible error conditions that may occur while processing an operation using the API.
Enumeration
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
String
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Data can consist of any characters
String
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Data can consist of any characters
String
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Data can consist of any characters
Enumeration
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
Enumeration
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.